core/androidx.core.app/[main]NotificationCompat/ProgressStyle

ProgressStyle

open class ProgressStyle : NotificationCompat.Style(source)

Helper class for generating large-format notifications that display progress to the user with a highly customizable progress bar with segments, points, a custom tracker icon, and custom icons at the start and end of the progress bar. If the platform does not provide large-format notifications, this method has no effect. The user will always see the normal notification view. This class is a "rebuilder": It attaches to a Builder object and modifies its behavior, like so:

new NotificationCompat.Builder(context)
  .setSmallIcon(R.drawable.ic_notification)
  .setColor(Color.GREEN)
  .setColorized(true)
  .setContentTitle("Arrive 10:08 AM").
  .setContentText("Dominique Ansel Bakery Soho")
  .addAction(new NotificationCompat.Action("Exit navigation",...))
  .setStyle(new NotificationCompat.ProgressStyle()
      .setStyledByProgress(false)
      .setProgress(456)
      .setProgressTrackerIcon(IconCompat.createWithResource(R.drawable.ic_driving_tracker))
      .addProgressSegment(new Segment(41).setColor(Color.BLACK))
      .addProgressSegment(new Segment(552).setColor(Color.YELLOW))
      .addProgressSegment(new Segment(253).setColor(Color.YELLOW))
      .addProgressSegment(new Segment(94).setColor(Color.BLUE))
      .addProgressPoint(new Point(60).setColor(Color.RED))
      .addProgressPoint(new Point(560).setColor(Color.YELLOW))
  )

NOTE: ProgressStyle Notifications are supported on Android 36 and above. If the SDK version is below 36, the ProgressStyle will fall back to the default notification style.

Constructors

constructor()

Types

class Point

A point within the progress bar, defining its position and color.

A segment of the progress bar, which defines its length and color.

Functions

addCompatExtras

@RestrictTo(value = LIBRARY_GROUP_PREFIX)

open fun addCompatExtras(@NonNull extras: @NonNull Bundle)

This is called with the extras of the framework Notification during the build process, after apply() has been called.

addProgressPoint

@NonNull

open fun addProgressPoint(@NonNull point: @NonNull NotificationCompat.ProgressStyle.Point): @NonNull NotificationCompat.ProgressStyle

Adds another point.

addProgressSegment

@NonNull

open fun addProgressSegment(@NonNull segment: @NonNull NotificationCompat.ProgressStyle.Segment): @NonNull NotificationCompat.ProgressStyle

Appends a segment to the end of the progress bar.

@RestrictTo(value = LIBRARY_GROUP_PREFIX)

open fun apply(builder: NotificationBuilderWithBuilderAccessor)

displayCustomViewInline

@RestrictTo(value = LIBRARY_GROUP_PREFIX)

open fun displayCustomViewInline(): Boolean

@IntRange(from = 0)

open fun getProgress(): Int

Gets the progress value of the progress bar.

getProgressEndIcon

@Nullable

open fun getProgressEndIcon(): @Nullable IconCompat

Gets the progress bar end icon.

@IntRange(from = 0)

open fun getProgressMax(): Int

Gets the sum of the lengths of all Segments in the style, which defines the maximum progress.

getProgressPoints

@NonNull

open fun getProgressPoints(): @NonNull List<NotificationCompat.ProgressStyle.Point>

Gets the points that are displayed on the progress bar.

getProgressSegments

@NonNull

open fun getProgressSegments(): @NonNull List<NotificationCompat.ProgressStyle.Segment>

Gets the segments that define the background layer of the progress bar.

getProgressStartIcon

@Nullable

open fun getProgressStartIcon(): @Nullable IconCompat

Gets the progress bar start icon.

getProgressTrackerIcon

@Nullable

open fun getProgressTrackerIcon(): @Nullable IconCompat

Gets the progress tracker icon for the progress bar.

isProgressIndeterminate

open fun isProgressIndeterminate(): Boolean

Get indeterminate value of the progress bar.

isStyledByProgress

open fun isStyledByProgress(): Boolean

Gets whether the progress bar's style is based on its progress.

@NonNull

open fun setProgress(@IntRange(from = 0) progress: Int): @NonNull NotificationCompat.ProgressStyle

Specifies the progress (in the same units as getLength) of the tracker along the length of the bar.

setProgressEndIcon

@NonNull

open fun setProgressEndIcon(@Nullable endIcon: @Nullable IconCompat): @NonNull NotificationCompat.ProgressStyle

An optional square icon that appears at the end of the progress bar.

setProgressIndeterminate

@NonNull

open fun setProgressIndeterminate(indeterminate: Boolean): @NonNull NotificationCompat.ProgressStyle

Used to indicate an initialization state without a known progress amount.

setProgressPoints

@NonNull

open fun setProgressPoints(@NonNull points: @NonNull List<NotificationCompat.ProgressStyle.Point>): @NonNull NotificationCompat.ProgressStyle

Replaces all the progress points.

setProgressSegments

@NonNull

open fun setProgressSegments(@NonNull progressSegments: @NonNull List<NotificationCompat.ProgressStyle.Segment>): @NonNull NotificationCompat.ProgressStyle

Sets or replaces the segments of the progress bar.

setProgressStartIcon

@NonNull

open fun setProgressStartIcon(@Nullable startIcon: @Nullable IconCompat): @NonNull NotificationCompat.ProgressStyle

An optional square icon that appears at the start of the progress bar.

setProgressTrackerIcon

@NonNull

open fun setProgressTrackerIcon(@Nullable trackerIcon: @Nullable IconCompat): @NonNull NotificationCompat.ProgressStyle

An optional icon that can appear as an overlay on the bar at the point of current progress.

setStyledByProgress

@NonNull

open fun setStyledByProgress(enabled: Boolean): @NonNull NotificationCompat.ProgressStyle

Indicates whether the segments and points will be styled differently based on whether they are behind or ahead of the current progress.